FHIR © HL7.org  |  Server Home  |  FHIR Server FHIR Server 3.4.11  |  FHIR Version n/a  User: [n/a]

Resource CapabilityStatement/FHIR Server from package hl7.fhir.us.medmorph-research-dex#current (203 ms)

Package hl7.fhir.us.medmorph-research-dex
Type CapabilityStatement
Id Id
FHIR Version R4
Source http://hl7.org/fhir/us/medmorph-research-dex/https://build.fhir.org/ig/HL7/fhir-medmorph-research-dex-ig/CapabilityStatement-medmorph-research-dex-ehr.html
Url http://hl7.org/fhir/us/medmorph-research-dex/CapabilityStatement/medmorph-research-dex-ehr
Version 0.1.0
Status draft
Date 2020-12-06
Name MedMorphResearchDataExchangeEHRCapabilityStatement
Title MedMorph Research Data Exchange EHR Capability Statement
Experimental False
Realm us
Authority hl7
Description This profile defines the expected capabilities of the ''EHR'' actor when conforming to the MedMorph Research Data Exchange IG. This role is responsible for allowing creation and retrieval of Group resources, along with retrieval of clinical data using the Group/$export operation.
Kind requirements

Resources that use this resource

No resources found


Resources that this resource uses

OperationDefinition
http://hl7.org/fhir/uv/bulkdata/OperationDefinition/group-export FHIR Bulk Data Group Level Export


Narrative

Note: links and images are rebased to the (stated) source

EHR

(Requirements Definition Capability Statement)

Canonical URL: http://hl7.org/fhir/us/medmorph-research-dex/CapabilityStatement/medmorph-research-dex-ehr

Published by: HL7 International - Public Health Work Group

This profile defines the expected capabilities of the EHR actor to support the MedMorph Research Data Exchange use cases. This actor is responsible for supporting Group Resource and Group export operations supporting the US Core profiles and the CDMH IG profiles.

General

FHIR Version: 4.0.1
Supported formats: json

REST behavior

The primary focus of the EHR is to allow the creation of a Group resource and support the Group export operation for the US Core and CDMH IG profiles.

Security:

Implementations must meet the general security requirements documented in FHIR Security guidance.

In addition the EHR needs to meet the security requirements as outlined in the Formal Specification - Security Section.

US Core Support

The EHR SHALL support the profiles listed in US Core Server capability statement as foundational FHIR profiles needed by the MedMorph Research Data Exchange IG.


CDMH IG Support

The EHR SHOULD support the profiles listed in CDMH IG for populating multiple common data models.


Resource summary

Resource Search Read Read Version Instance History Resource History Create Update Delete Operations
Group SHALL SHALL SHALL Bulk Data IG: Group/$export: SHALL
US Core Profiles SHALL
CDMH Profiles SHALL


Group

Profile: MedMorph Research Group Profile

Interactions

Name Description
  search

Allows creation of a specific Group resource instances to record participants in a research program.

  search

Allows searching of specific Group resource profile instances.

  read

Allows retrieval of specific Group resource profile instances

  Bulk Data IG: Group/$export operation

Allows retrieval of specific data associated with patients who are part of the Group.



Search

Parameter Type Definition & Chaining
identifier token Search using identifiers.
name string Search using Group name which represents the Research program name.

US Core Profiles

Profile: Profiles listed in US Core

Interactions

Name Description
  read

Allows retrieval of specific US Core resource profile instances as part of the Group/$export operation.



CDMH Profiles

Profile: Profiles listed in CDMH IG

Interactions

Name Description
  read

Allows retrieval of specific CDMH resource profile instances as part of the Group/$export operation.




Source

{
  "resourceType" : "CapabilityStatement",
  "id" : "medmorph-research-dex-ehr",
  "text" : {
    "status" : "generated",
    "div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\">\n <h2>EHR</h2>\n <p>(Requirements Definition Capability Statement)</p>\n <p>Canonical URL: http://hl7.org/fhir/us/medmorph-research-dex/CapabilityStatement/medmorph-research-dex-ehr</p>\n <p>Published by: <b>HL7 International - Public Health Work Group</b>\n </p>\n <p>This profile defines the expected capabilities of the <i>EHR </i> actor to support the MedMorph Research Data Exchange use cases. \n This actor is responsible for supporting Group Resource and Group export operations supporting the US Core profiles and the CDMH IG profiles.</p>\n <h2>General</h2>\n <div class=\"table-wrapper\">\n <table>\n <tbody>\n <tr>\n <th>FHIR Version:</th>\n <td>4.0.1</td>\n </tr>\n <tr>\n <th>Supported formats:</th>\n <td>json</td>\n </tr>\n </tbody>\n </table>\n </div>\n <h2>REST behavior</h2>\n <p>The primary focus of the EHR is to allow the creation of a Group resource and support the Group export operation for the US Core and CDMH IG profiles. </p>\n <p>\n <b>Security:</b>\n </p>\n <p>Implementations must meet the general security requirements documented in FHIR <a href=\"http://hl7.org/fhir/security.html\">Security guidance</a>.</p>\n <p>In addition the EHR needs to meet the security requirements as outlined in the <a href=\"spec.html#smart-on-fhir-backend-services-authorization-requirements\">Formal Specification - Security Section.</a></p>\n\n <h3>US Core Support</h3>\n\n <p>\n The EHR <b>SHALL</b> support the profiles listed in \n <a href=\"http://hl7.org/fhir/us/core/STU3.1.1/CapabilityStatement-us-core-server.html\">US Core Server capability statement</a> as foundational FHIR profiles needed by the MedMorph Research Data Exchange IG.\n </p>\n <br/>\n\n <h3>CDMH IG Support</h3>\n\n <p>\n The EHR <b>SHOULD</b> support the profiles listed in \n <a href=\"https://build.fhir.org/ig/HL7/cdmh/artifacts.html#structures-resource-profiles\">CDMH IG</a> for populating multiple common data models.\n </p>\n <br/>\n\n <h3>Resource summary</h3>\n <div class=\"table-wrapper\">\n <table class=\"grid\">\n <thead>\n <tr>\n <th>Resource</th>\n <th>Search</th>\n <th>Read</th>\n <th>Read Version</th>\n <th>Instance History</th>\n <th>Resource History</th>\n <th>Create</th>\n <th>Update</th>\n <th>Delete</th>\n <th>Operations</th>\n </tr>\n </thead>\n <tbody>\n <tr>\n <th><a href=\"http://hl7.org/fhir/R4/group.html\">Group</a></th>\n <td>\n <a href=\"#Group-search\" title=\"Allows search of a specific Group Resource instances using names and identifiers.\">SHALL</a>\n </td>\n <td>\n <a href=\"#Group-read\" title=\"Allows retrieval of specific Group instances using ids.\">SHALL</a>\n </td>\n <td>\n </td>\n <td> \n </td>\n <td>\n </td>\n <td>\n <a href=\"#Group-create\" title=\"Allows creation of a specific Group Resource instance to record participants in a research program.\">SHALL</a>\n </td>\n <td>\n </td>\n <td>\n </td>\n <td>\n <a href=\"#Group-export\" title=\"Allows bulk export of data using the Group/$export operation\">Bulk Data IG: Group/$export: SHALL</a>\n </td>\n </tr>\n <tr>\n <th>US Core Profiles</th>\n <td>\n </td>\n <td>\n <a href=\"#USCore-read\" title=\"Allows retrieval of a specific US Core Resource instances as part of the Group/$export operation.\">SHALL</a>\n </td>\n <td>\n </td>\n <td> \n </td>\n <td>\n </td>\n <td>\n </td>\n <td>\n </td>\n\t\t\t <td>\n </td>\n <td>\n </td>\n </tr>\n <tr>\n <th>CDMH Profiles</th>\n <td>\n </td>\n <td>\n <a href=\"#CDMH-read\" title=\"Allows retrieval of a specific CDMH Resource instances as part of the Group/$export operation.\">SHALL</a>\n </td>\n <td>\n </td>\n <td> \n </td>\n <td>\n </td>\n <td>\n </td>\n <td>\n </td>\n <td>\n </td>\n <td>\n </td>\n </tr>\n </tbody>\n </table>\n </div>\n \n <br/>\n <br/>\n \n <h3>\n <a href=\"http://hl7.org/fhir/group.html\">Group</a>\n </h3>\n <p>Profile: <a href=\"https://build.fhir.org/ig/HL7/fhir-medmorph//StructureDefinition-research-participant-group.html\">MedMorph Research Group Profile</a>\n </p>\n <h4>Interactions</h4>\n <div class=\"table-wrapper\">\n <table class=\"list\">\n <thead>\n <tr>\n <th>Name</th>\n <th>Description</th>\n </tr>\n </thead>\n <tbody>\n <tr>\n <th>\n <a name=\"Group-create\"> </a>\n <span>search</span>\n </th>\n <td>\n <p>Allows creation of a specific Group resource instances to record participants in a research program.</p>\n </td>\n </tr>\n <tr>\n <th>\n <a name=\"Group-search\"> </a>\n <span>search</span>\n </th>\n <td>\n <p>Allows searching of specific Group resource profile instances.</p>\n </td>\n </tr>\n <tr>\n <th>\n <a name=\"Group-read\"> </a>\n <span>read</span>\n </th>\n <td>\n <p>Allows retrieval of specific Group resource profile instances</p>\n </td>\n </tr> \n <tr>\n <th>\n <a name=\"Group-export\"> </a>\n <span>Bulk Data IG: Group/$export operation</span>\n </th>\n <td>\n <p>Allows retrieval of specific data associated with patients who are part of the Group.</p>\n </td>\n </tr> \n </tbody>\n </table>\n </div>\n <br/>\n <br/> \n\n <h4>Search</h4>\n <div class=\"table-wrapper\">\n <table class=\"list\">\n <thead>\n <tr>\n <th>Parameter</th>\n <th>Type</th>\n <th>Definition &amp; Chaining</th>\n </tr>\n </thead>\n <tbody>\n <tr>\n <th>identifier</th>\n <td>token</td>\n <td>Search using identifiers.</td>\n </tr>\n <tr>\n <th>name</th>\n <td>string</td>\n <td>Search using Group name which represents the Research program name.</td>\n </tr>\n </tbody>\n </table>\n </div>\n\n <h3>\n <a href=\"http://hl7.org/fhir/us/core\">US Core Profiles</a>\n </h3>\n <p>Profile: <a href=\"http://hl7.org/fhir/us/core/STU3.1.1/CapabilityStatement-us-core-server.html\">Profiles listed in US Core</a>\n </p>\n <h4>Interactions</h4>\n <div class=\"table-wrapper\">\n <table class=\"list\">\n <thead>\n <tr>\n <th>Name</th>\n <th>Description</th>\n </tr>\n </thead>\n <tbody>\n <tr>\n <th>\n <a name=\"USCore-read\"> </a>\n <span>read</span>\n </th>\n <td>\n <p>Allows retrieval of specific US Core resource profile instances as part of the Group/$export operation.</p>\n </td>\n </tr> \n </tbody>\n </table>\n </div>\n <br/>\n <br/> \n\n <h3>\n <a href=\"https://build.fhir.org/ig/HL7/cdmh/artifacts.html\">CDMH Profiles</a>\n </h3>\n <p>Profile: <a href=\"https://build.fhir.org/ig/HL7/cdmh/artifacts.html\">Profiles listed in CDMH IG</a>\n </p>\n <h4>Interactions</h4>\n <div class=\"table-wrapper\">\n <table class=\"list\">\n <thead>\n <tr>\n <th>Name</th>\n <th>Description</th>\n </tr>\n </thead>\n <tbody>\n <tr>\n <th>\n <a name=\"CDMH-read\"> </a>\n <span>read</span>\n </th>\n <td>\n <p>Allows retrieval of specific CDMH resource profile instances as part of the Group/$export operation.</p>\n </td>\n </tr> \n </tbody>\n </table>\n </div>\n <br/>\n <br/>\n \n </div>"
  },
  "url" : "http://hl7.org/fhir/us/medmorph-research-dex/CapabilityStatement/medmorph-research-dex-ehr",
  "version" : "0.1.0",
  "name" : "MedMorphResearchDataExchangeEHRCapabilityStatement",
  "title" : "MedMorph Research Data Exchange EHR Capability Statement",
  "status" : "draft",
  "date" : "2020-12-06",
  "publisher" : "HL7 International - Public Health Work Group",
  "contact" : [
    {
      "telecom" : [
        {
          "system" : "url",
          "value" : "http://hl7.org/Special/committees/pher"
        }
      ]
    }
  ],
  "description" : "This profile defines the expected capabilities of the ''EHR'' actor when conforming to the MedMorph Research Data Exchange IG. This role is responsible for allowing creation and retrieval of Group resources, along with retrieval of clinical data using the Group/$export operation.",
  "jurisdiction" : [
    {
      "coding" : [
        {
          "system" : "urn:iso:std:iso:3166",
          "code" : "US"
        }
      ]
    }
  ],
  "kind" : "requirements",
  "fhirVersion" : "4.0.1",
  "format" : [
    "json"
  ],
  "rest" : [
    {
      "mode" : "server",
      "documentation" : "The focus of the EHR is to allow creation and retrieval of Group resources and clinical data using the Group/$export operation.",
      "security" : {
        "description" : "Implementations must meet the general security requirements documented in the security section of the implementation guide."
      },
      "resource" : [
        {
          "type" : "Group",
          "interaction" : [
            {
              "extension" : [
                {
                  "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode" : "SHALL"
                }
              ],
              "code" : "read",
              "documentation" : "Allows retrieval of a specific Group instance."
            },
            {
              "extension" : [
                {
                  "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode" : "SHALL"
                }
              ],
              "code" : "create",
              "documentation" : "Allows creation of a Group resource instance."
            },
            {
              "extension" : [
                {
                  "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode" : "SHALL"
                }
              ],
              "code" : "search-type",
              "documentation" : "Allows search of a Group resource instance using identifiers and names."
            }
          ],
          "searchParam" : [
            {
              "extension" : [
                {
                  "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode" : "SHALL"
                }
              ],
              "name" : "identifier",
              "definition" : "http://hl7.org/fhir/SearchParameter/Group-identifier",
              "type" : "token"
            }
          ],
          "operation" : [
            {
              "name" : "export",
              "definition" : "http://hl7.org/fhir/uv/bulkdata/OperationDefinition/group-export"
            }
          ]
        }
      ]
    }
  ]
}

XIG built as of ??metadata-date??. Found ??metadata-resources?? resources in ??metadata-packages?? packages.